Plugins/WebKit Message View/AIWebKitMessageViewPlugin.h

   1 /*
   2  * Adium is the legal property of its developers, whose names are listed in the copyright file included
   3  * with this source distribution.
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the License,
   7  * or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  10  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
  11  * Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  15  */
  16
  17 #import <Adium/AIPlugin.h>
  18 #import <WebKit/WebKit.h>
  19 #import <Adium/AIInterfaceControllerProtocol.h>
  20
  21 /*!
  22  *      @brief Preference group for webkit display prefs
  23  *      @see AIPreferencesController
  24  */
  25 #define PREF_GROUP_WEBKIT_MESSAGE_DISPLAY               @"WebKit Message Display"
  26
  27 /*!
  28  *      @brief Preference group for custom images as background in the webkit message view
  29  *      @see AIPreferencesController
  30  */
  31 #define PREF_GROUP_WEBKIT_BACKGROUND_IMAGES             @"WebKit Custom Backgrounds"
  32
  33 /*!
  34  *      @brief Preference group for default settings
  35  *      @see AIPreferencesController
  36  */
  37 #define WEBKIT_DEFAULT_PREFS                                    @"WebKit Defaults"
  38
  39 /*!
  40  *      @brief The bundle identifier of the style we revert to if the preferred style isn't available
  41  */
  42 #define WEBKIT_DEFAULT_STYLE                                    @"com.adiumx.stockholm.style"
  43
  44 /*!
  45  *      @brief The path to the currently selected message style
  46  */
  47 #define KEY_CURRENT_WEBKIT_STYLE_PATH                   @"Current Style Path"
  48
  49 /*!
  50  *      @brief Key for the preference controlling whether we should show user icons in the message view
  51  */
  52 #define KEY_WEBKIT_SHOW_USER_ICONS                              @"Show User Icons"
  53
  54 /*!
  55  *      @brief Key for the preference controlling whether we should show a header in the message view
  56  */
  57 #define KEY_WEBKIT_SHOW_HEADER                                  @"Show Header"
  58
  59 /*!
  60  *      @brief Key for the preference controlling whether we should show received message colors
  61  */
  62 #define KEY_WEBKIT_SHOW_MESSAGE_COLORS                  @"Show Message Colors"
  63
  64 /*!
  65  *      @brief Key for the preference controlling whether we should show received message fonts
  66  */
  67 #define KEY_WEBKIT_SHOW_MESSAGE_FONTS                   @"Show Message Fonts"
  68
  69 /*!
  70  *      @brief Key for the preference controlling how the usernames should be displayed
  71  */
  72 #define KEY_WEBKIT_NAME_FORMAT                                  @"Name Format"
  73
  74 /*!
  75  *      @brief Key for the preference controlling whether we're using a custom format for usernames
  76  */
  77 #define KEY_WEBKIT_USE_NAME_FORMAT                              @"Use Custom Name Format"
  78
  79 /*!
  80  *      @brief Key for the preference controlling what message style is in use
  81  */
  82 #define KEY_WEBKIT_STYLE                                                @"Message Style"
  83
  84 /*!
  85  *      @brief Key for the preference controlling how the timestamp on messages should be formatted
  86  */
  87 #define KEY_WEBKIT_TIME_STAMP_FORMAT                    @"Time Stamp"
  88
  89 /*!
  90  *      @brief Key for the preference controlling the minimum font size in the message view
  91  */
  92 #define KEY_WEBKIT_MIN_FONT_SIZE                                @"Min Font Size"
  93
  94 #define NEW_CONTENT_RETRY_DELAY                                 0.01
  95
  96 @class ESWebKitMessageViewPreferences, AIChat, AIWebkitMessageViewStyle;
  97
  98 /*!
  99  *      @class AIWebKitMessageViewPlugin AIWebKitMessageViewPlugin.h
 100  *      @brief Handles loading the WKMV plugin into Adium
 101  *      @see AIWebKitMessageViewController
 102  */
 103 @interface AIWebKitMessageViewPlugin : AIPlugin <AIMessageDisplayPlugin> {
 104         ESWebKitMessageViewPreferences  *preferences;
 105         NSMutableDictionary                             *styleDictionary;
 106         AIWebkitMessageViewStyle                *currentStyle;
 107 }
 108
 109 /*!
 110  *      @return a new webkit message view controller initialized to display inChat
 111  *      @param inChat the chat that the message view will display
 112  */
 113 - (id <AIMessageDisplayController>)messageDisplayControllerForChat:(AIChat *)inChat;
 114
 115 /*!
 116  *      This method is fairly expensive the first time it's run; however, the first time will almost always been in a thread at startup, to preload the styles. This method is threadsafe.
 117  *      @return A dictionary of all available message styles, with their identifiers as keys
 118  */
 119 - (NSDictionary *)availableMessageStyles;
 120
 121 /*!
 122  *      @return a message style NSBundle
 123  *      @param identifier the identifier of the message style
 124  */
 125 - (NSBundle *)messageStyleBundleWithIdentifier:(NSString *)identifier;
 126
 127 /*!
 128  *      @brief Returns a preference key which is style specific
 129  *      @param key The preference key
 130  *      @param style The style name it will be specific to
 131  */
 132 - (NSString *)styleSpecificKey:(NSString *)key forStyle:(NSString *)style;
 133
 134 /*!
 135  *      @brief Returns the shared instance of the currently used message style
 136  */
 137 - (AIWebkitMessageViewStyle *) currentMessageStyle;
 138
 139 @end